Skip to content

Improve the error message when collecting restart files.#708

Merged
Qian-HuiChen merged 2 commits intopayu-org:masterfrom
ACCESS-NRI:705-om3-errormsg
Apr 8, 2026
Merged

Improve the error message when collecting restart files.#708
Qian-HuiChen merged 2 commits intopayu-org:masterfrom
ACCESS-NRI:705-om3-errormsg

Conversation

@Qian-HuiChen
Copy link
Copy Markdown
Collaborator

@Qian-HuiChen Qian-HuiChen commented Mar 31, 2026

Make the FileNotFound error message clearer when collecting restart files.

Closes #705.
Ref issue in OM3 config repo.

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 31, 2026 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 64.44%. Comparing base (6886c36) to head (fe02bf3).
⚠️ Report is 3 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master     #708      +/-   ##
==========================================
+ Coverage   64.42%   64.44%   +0.02%     
==========================================
  Files          68       68              
  Lines        5596     5597       +1     
==========================================
+ Hits         3605     3607       +2     
+ Misses       1991     1990       -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Qian-HuiChen
Copy link
Copy Markdown
Collaborator Author

Qian-HuiChen commented Mar 31, 2026 •
edited
Loading

@manodeep @anton-seaice thanks for raising the issue!
This PR aims to make payu deliver a clearer error message to the users. You feedback/comments/suggestions are highly appreciated 🙂
Edit:
The current error message will be:

::
File "/home/.../cesm_cmeps.py", line 336, in _collect_restart_files
    raise FileNotFoundError(
FileNotFoundError:
Payu Error: Restart pointer file not found at the end of payu run: /scratch/.../100km_jra_ryf/rpointer.cpl
Possible cause: model runtime is shorter than the restart write frequency.
Fix:
    1. Remove the incomplete restart subdirectory in the archive path
    2. Adjust the restart write frequency to be shorter than/equal to the model runtime.

anton-seaice
anton-seaice reviewed Mar 31, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@anton-seaice anton-seaice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good - could you add a test in

https://github.com/ACCESS-NRI/payu/blob/705-om3-errormsg/test/models/access-om3/test_access_om3.py

anton-seaice
anton-seaice approved these changes Apr 8, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@anton-seaice anton-seaice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Qian-HuiChen

@manodeep
Copy link
Copy Markdown
Collaborator

manodeep commented Apr 8, 2026

Thanks @Qian-HuiChen (and Anton for the review) - that error message is now much more user-friendly :)

@Qian-HuiChen Qian-HuiChen merged commit 3fae6fd into payu-org:master Apr 8, 2026
8 checks passed
@Qian-HuiChen Qian-HuiChen deleted the 705-om3-errormsg branch April 8, 2026 04:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@anton-seaice anton-seaice anton-seaice approved these changes

@aidanheerdegen aidanheerdegen Awaiting requested review from aidanheerdegen

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Better error message for missing restart files in OM3

3 participants

@Qian-HuiChen @manodeep @anton-seaice